File: C:/Ruby27-x64/share/doc/ruby/html/RDoc/MethodAttr.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class RDoc::MethodAttr - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="CodeObject.html">RDoc::CodeObject</a>
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="../Comparable.html">Comparable</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-3C-3D-3E">#<=></a>
<li ><a href="#method-i-add_alias">#add_alias</a>
<li ><a href="#method-i-aref">#aref</a>
<li ><a href="#method-i-aref_prefix">#aref_prefix</a>
<li ><a href="#method-i-block_params-3D">#block_params=</a>
<li class="calls-super" ><a href="#method-i-documented-3F">#documented?</a>
<li ><a href="#method-i-full_name">#full_name</a>
<li ><a href="#method-i-html_name">#html_name</a>
<li ><a href="#method-i-name_prefix">#name_prefix</a>
<li ><a href="#method-i-output_name">#output_name</a>
<li class="calls-super" ><a href="#method-i-parent_name">#parent_name</a>
<li ><a href="#method-i-path">#path</a>
<li ><a href="#method-i-pretty_name">#pretty_name</a>
<li ><a href="#method-i-search_record">#search_record</a>
<li ><a href="#method-i-see">#see</a>
<li class="calls-super" ><a href="#method-i-store-3D">#store=</a>
<li ><a href="#method-i-type">#type</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-RDoc::MethodAttr">
<h1 id="class-RDoc::MethodAttr" class="class">
class RDoc::MethodAttr
</h1>
<section class="description">
<p>Abstract class representing either a method or an attribute.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-aliases" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">aliases</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p><a href="../Array.html"><code>Array</code></a> of other names for this method/attribute</p>
</div>
</div>
<div id="attribute-i-arglists" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">arglists</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The <a href="MethodAttr.html#attribute-i-call_seq"><code>call_seq</code></a> or the <a href="MethodAttr.html#attribute-i-param_seq"><code>param_seq</code></a> with method name, if there is no call_seq.</p>
</div>
</div>
<div id="attribute-i-block_params" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">block_params</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>Parameters yielded by the called block</p>
</div>
</div>
<div id="attribute-i-call_seq" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">call_seq</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Different ways to call this method</p>
</div>
</div>
<div id="attribute-i-is_alias_for" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">is_alias_for</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The method/attribute we're aliasing</p>
</div>
</div>
<div id="attribute-i-name" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">name</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Name of this method/attribute.</p>
</div>
</div>
<div id="attribute-i-param_seq" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">param_seq</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>Pretty parameter list for this method</p>
</div>
</div>
<div id="attribute-i-params" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">params</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Parameters for this method</p>
</div>
</div>
<div id="attribute-i-singleton" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">singleton</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Is this a singleton method/attribute?</p>
</div>
</div>
<div id="attribute-i-text" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">text</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>Source file token stream</p>
</div>
</div>
<div id="attribute-i-visibility" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">visibility</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>public, protected, private</p>
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(text, name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="MethodAttr.html"><code>MethodAttr</code></a> from token stream <code>text</code> and method or attribute name <code>name</code>.</p>
<p>Usually this is called by super from a subclass.</p>
<div class="method-calls-super">
Calls superclass method
<a href="CodeObject.html#method-c-new"><code>RDoc::CodeObject::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rdoc/method_attr.rb, line 78</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span> <span class="ruby-identifier">text</span>, <span class="ruby-identifier">name</span>
<span class="ruby-keyword">super</span>()
<span class="ruby-ivar">@text</span> = <span class="ruby-identifier">text</span>
<span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
<span class="ruby-ivar">@aliases</span> = []
<span class="ruby-ivar">@is_alias_for</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@parent_name</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@singleton</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@visibility</span> = <span class="ruby-value">:public</span>
<span class="ruby-ivar">@see</span> = <span class="ruby-keyword">false</span>
<span class="ruby-ivar">@arglists</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@block_params</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@call_seq</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@param_seq</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@params</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-3C-3D-3E" class="method-detail ">
<div class="method-heading">
<span class="method-name"><=></span><span
class="method-args">(other)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Order by <a href="MethodAttr.html#attribute-i-singleton"><code>singleton</code></a> then <a href="MethodAttr.html#attribute-i-name"><code>name</code></a></p>
<div class="method-source-code" id="3C-3D-3E-source">
<pre><span class="ruby-comment"># File lib/rdoc/method_attr.rb, line 113</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><=></span>(<span class="ruby-identifier">other</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:singleton</span>) <span class="ruby-operator">&&</span>
<span class="ruby-identifier">other</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:name</span>)
[ <span class="ruby-ivar">@singleton</span> <span class="ruby-operator">?</span> <span class="ruby-value">0</span> <span class="ruby-operator">:</span> <span class="ruby-value">1</span>, <span class="ruby-identifier">name</span>] <span class="ruby-operator"><=></span>
[<span class="ruby-identifier">other</span>.<span class="ruby-identifier">singleton</span> <span class="ruby-operator">?</span> <span class="ruby-value">0</span> <span class="ruby-operator">:</span> <span class="ruby-value">1</span>, <span class="ruby-identifier">other</span>.<span class="ruby-identifier">name</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-add_alias" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_alias</span><span
class="method-args">(an_alias, context)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Abstract method. Contexts in their building phase call this to register a new alias for this known method/attribute.</p>
<ul><li>
<p>creates a new AnyMethod/Attribute named <code>an_alias.new_name</code>;</p>
</li><li>
<p>adds <code>self</code> as an alias for the new method or attribute</p>
</li><li>
<p>adds the method or attribute to <a href="MethodAttr.html#attribute-i-aliases"><code>aliases</code></a></p>
</li><li>
<p>adds the method or attribute to <code>context</code>.</p>
</li></ul>
<div class="method-source-code" id="add_alias-source">
<pre><span class="ruby-comment"># File lib/rdoc/method_attr.rb, line 209</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_alias</span>(<span class="ruby-identifier">an_alias</span>, <span class="ruby-identifier">context</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-aref" class="method-detail ">
<div class="method-heading">
<span class="method-name">aref</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>HTML fragment reference for this method</p>
<div class="method-source-code" id="aref-source">
<pre><span class="ruby-comment"># File lib/rdoc/method_attr.rb, line 216</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">aref</span>
<span class="ruby-identifier">type</span> = <span class="ruby-identifier">singleton</span> <span class="ruby-operator">?</span> <span class="ruby-string">'c'</span> <span class="ruby-operator">:</span> <span class="ruby-string">'i'</span>
<span class="ruby-comment"># % characters are not allowed in html names => dash instead</span>
<span class="ruby-node">"#{aref_prefix}-#{type}-#{html_name}"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-aref_prefix" class="method-detail ">
<div class="method-heading">
<span class="method-name">aref_prefix</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Prefix for <code>aref</code>, defined by subclasses.</p>
<div class="method-source-code" id="aref_prefix-source">
<pre><span class="ruby-comment"># File lib/rdoc/method_attr.rb, line 225</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">aref_prefix</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-block_params-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">block_params=</span><span
class="method-args">(value)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Attempts to sanitize the content passed by the Ruby parser: remove outer parentheses, etc.</p>
<div class="method-source-code" id="block_params-3D-source">
<pre><span class="ruby-comment"># File lib/rdoc/method_attr.rb, line 233</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">block_params=</span>(<span class="ruby-identifier">value</span>)
<span class="ruby-comment"># 'yield.to_s' or 'assert yield, msg'</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@block_params</span> = <span class="ruby-string">''</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^[\.,]/</span>
<span class="ruby-comment"># remove trailing 'if/unless ...'</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@block_params</span> = <span class="ruby-string">''</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^(if|unless)\s/</span>
<span class="ruby-identifier">value</span> = <span class="ruby-node">$1</span>.<span class="ruby-identifier">strip</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^(.+)\s(if|unless)\s/</span>
<span class="ruby-comment"># outer parentheses</span>
<span class="ruby-identifier">value</span> = <span class="ruby-node">$1</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^\s*\((.*)\)\s*$/</span>
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">value</span>.<span class="ruby-identifier">strip</span>
<span class="ruby-comment"># proc/lambda</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@block_params</span> = <span class="ruby-node">$1</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^(proc|lambda)(\s*\{|\sdo)/</span>
<span class="ruby-comment"># surrounding +...+ or [...]</span>
<span class="ruby-identifier">value</span> = <span class="ruby-node">$1</span>.<span class="ruby-identifier">strip</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^\+(.*)\+$/</span>
<span class="ruby-identifier">value</span> = <span class="ruby-node">$1</span>.<span class="ruby-identifier">strip</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^\[(.*)\]$/</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@block_params</span> = <span class="ruby-string">''</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-comment"># global variable</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@block_params</span> = <span class="ruby-string">'str'</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^\$[&0-9]$/</span>
<span class="ruby-comment"># wipe out array/hash indices</span>
<span class="ruby-identifier">value</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp">/(\w)\[[^\[]+\]/</span>, <span class="ruby-string">'\1'</span>)
<span class="ruby-comment"># remove @ from class/instance variables</span>
<span class="ruby-identifier">value</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp">/@@?([a-z0-9_]+)/</span>, <span class="ruby-string">'\1'</span>)
<span class="ruby-comment"># method calls => method name</span>
<span class="ruby-identifier">value</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp">/([A-Z:a-z0-9_]+)\.([a-z0-9_]+)(\s*\(\s*[a-z0-9_.,\s]*\s*\)\s*)?/</span>) <span class="ruby-keyword">do</span>
<span class="ruby-keyword">case</span> <span class="ruby-node">$2</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">'to_s'</span> <span class="ruby-keyword">then</span> <span class="ruby-node">$1</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">'const_get'</span> <span class="ruby-keyword">then</span> <span class="ruby-string">'const'</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">'new'</span> <span class="ruby-keyword">then</span>
<span class="ruby-node">$1</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">'::'</span>).<span class="ruby-identifier">last</span>. <span class="ruby-comment"># ClassName => class_name</span>
<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/([A-Z]+)([A-Z][a-z])/</span>,<span class="ruby-string">'\1_\2'</span>).
<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/([a-z\d])([A-Z])/</span>,<span class="ruby-string">'\1_\2'</span>).
<span class="ruby-identifier">downcase</span>
<span class="ruby-keyword">else</span>
<span class="ruby-node">$2</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># class prefixes</span>
<span class="ruby-identifier">value</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp">/[A-Za-z0-9_:]+::/</span>, <span class="ruby-string">''</span>)
<span class="ruby-comment"># simple expressions</span>
<span class="ruby-identifier">value</span> = <span class="ruby-node">$1</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^([a-z0-9_]+)\s*[-*+\/]/</span>
<span class="ruby-ivar">@block_params</span> = <span class="ruby-identifier">value</span>.<span class="ruby-identifier">strip</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-documented-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">documented?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>A method/attribute is documented if any of the following is true:</p>
<ul><li>
<p>it was marked with :nodoc:;</p>
</li><li>
<p>it has a comment;</p>
</li><li>
<p>it is an alias for a documented method;</p>
</li><li>
<p>it has a <code>#see</code> method that is documented.</p>
</li></ul>
<div class="method-calls-super">
Calls superclass method
<a href="CodeObject.html#method-i-documented-3F"><code>RDoc::CodeObject#documented?</code></a>
</div>
<div class="method-source-code" id="documented-3F-source">
<pre><span class="ruby-comment"># File lib/rdoc/method_attr.rb, line 132</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">documented?</span>
<span class="ruby-keyword">super</span> <span class="ruby-keyword">or</span>
(<span class="ruby-identifier">is_alias_for</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">is_alias_for</span>.<span class="ruby-identifier">documented?</span>) <span class="ruby-keyword">or</span>
(<span class="ruby-identifier">see</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">see</span>.<span class="ruby-identifier">documented?</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-full_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">full_name</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Full method/attribute name including namespace</p>
<div class="method-source-code" id="full_name-source">
<pre><span class="ruby-comment"># File lib/rdoc/method_attr.rb, line 300</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">full_name</span>
<span class="ruby-ivar">@full_name</span> <span class="ruby-operator">||=</span> <span class="ruby-node">"#{parent_name}#{pretty_name}"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-html_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">html_name</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>HTML id-friendly method/attribute name</p>
<div class="method-source-code" id="html_name-source">
<pre><span class="ruby-comment"># File lib/rdoc/method_attr.rb, line 291</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">html_name</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">'cgi'</span>
<span class="ruby-constant">CGI</span>.<span class="ruby-identifier">escape</span>(<span class="ruby-ivar">@name</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-string">'-'</span>, <span class="ruby-string">'-2D'</span>)).<span class="ruby-identifier">gsub</span>(<span class="ruby-string">'%'</span>,<span class="ruby-string">'-'</span>).<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/^-/</span>, <span class="ruby-string">''</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-name_prefix" class="method-detail ">
<div class="method-heading">
<span class="method-name">name_prefix</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>'::' for a class method/attribute, '#' for an instance method.</p>
<div class="method-source-code" id="name_prefix-source">
<pre><span class="ruby-comment"># File lib/rdoc/method_attr.rb, line 319</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">name_prefix</span>
<span class="ruby-ivar">@singleton</span> <span class="ruby-operator">?</span> <span class="ruby-string">'::'</span> <span class="ruby-operator">:</span> <span class="ruby-string">'#'</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-output_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">output_name</span><span
class="method-args">(context)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Name for output to HTML. For class methods the full name with a “.” is used like <code>SomeClass.method_name</code>. For instance methods the class name is used if <code>context</code> does not match the parent.</p>
<dl class="rdoc-list note-list"><dt>This is to help prevent people from using
<dd>
<p>to call class methods.</p>
</dd></dl>
<div class="method-source-code" id="output_name-source">
<pre><span class="ruby-comment"># File lib/rdoc/method_attr.rb, line 330</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">output_name</span> <span class="ruby-identifier">context</span>
<span class="ruby-keyword">return</span> <span class="ruby-node">"#{name_prefix}#{@name}"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">context</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">parent</span>
<span class="ruby-node">"#{parent_name}#{@singleton ? '.' : '#'}#{@name}"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-parent_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">parent_name</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Name of our parent with special handling for un-marshaled methods</p>
<div class="method-calls-super">
Calls superclass method
<a href="CodeObject.html#method-i-parent_name"><code>RDoc::CodeObject#parent_name</code></a>
</div>
<div class="method-source-code" id="parent_name-source">
<pre><span class="ruby-comment"># File lib/rdoc/method_attr.rb, line 360</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parent_name</span>
<span class="ruby-ivar">@parent_name</span> <span class="ruby-operator">||</span> <span class="ruby-keyword">super</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-path" class="method-detail ">
<div class="method-heading">
<span class="method-name">path</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Path to this method for use with HTML generator output.</p>
<div class="method-source-code" id="path-source">
<pre><span class="ruby-comment"># File lib/rdoc/method_attr.rb, line 353</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">path</span>
<span class="ruby-node">"#{@parent.path}##{aref}"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-pretty_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">pretty_name</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Method/attribute name with class/instance indicator</p>
<div class="method-source-code" id="pretty_name-source">
<pre><span class="ruby-comment"># File lib/rdoc/method_attr.rb, line 339</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">pretty_name</span>
<span class="ruby-node">"#{name_prefix}#{@name}"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-search_record" class="method-detail ">
<div class="method-heading">
<span class="method-name">search_record</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Used by RDoc::Generator::JsonIndex to create a record for the search engine.</p>
<div class="method-source-code" id="search_record-source">
<pre><span class="ruby-comment"># File lib/rdoc/method_attr.rb, line 398</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_record</span>
[
<span class="ruby-ivar">@name</span>,
<span class="ruby-identifier">full_name</span>,
<span class="ruby-ivar">@name</span>,
<span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">full_name</span>,
<span class="ruby-identifier">path</span>,
<span class="ruby-identifier">params</span>,
<span class="ruby-identifier">snippet</span>(<span class="ruby-ivar">@comment</span>),
]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-see" class="method-detail ">
<div class="method-heading">
<span class="method-name">see</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>A method/attribute to look at, in particular if this method/attribute has no documentation.</p>
<p>It can be a method/attribute of the superclass or of an included module, including the <a href="../Kernel.html"><code>Kernel</code></a> module, which is always appended to the included modules.</p>
<p>Returns <code>nil</code> if there is no such method/attribute. The <code>#is_alias_for</code> method/attribute, if any, is not included.</p>
<p>Templates may generate a “see also …” if this method/attribute has documentation, and “see …” if it does not.</p>
<div class="method-source-code" id="see-source">
<pre><span class="ruby-comment"># File lib/rdoc/method_attr.rb, line 152</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">see</span>
<span class="ruby-ivar">@see</span> = <span class="ruby-identifier">find_see</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@see</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">false</span>
<span class="ruby-ivar">@see</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-store-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">store=</span><span
class="method-args">(store)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the store for this class or module and its contained code objects.</p>
<div class="method-calls-super">
Calls superclass method
<a href="CodeObject.html#method-i-store-3D"><code>RDoc::CodeObject#store=</code></a>
</div>
<div class="method-source-code" id="store-3D-source">
<pre><span class="ruby-comment"># File lib/rdoc/method_attr.rb, line 160</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">store=</span> <span class="ruby-identifier">store</span>
<span class="ruby-keyword">super</span>
<span class="ruby-ivar">@file</span> = <span class="ruby-ivar">@store</span>.<span class="ruby-identifier">add_file</span> <span class="ruby-ivar">@file</span>.<span class="ruby-identifier">full_name</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@file</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-type" class="method-detail ">
<div class="method-heading">
<span class="method-name">type</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Type of method/attribute (class or instance)</p>
<div class="method-source-code" id="type-source">
<pre><span class="ruby-comment"># File lib/rdoc/method_attr.rb, line 346</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">type</span>
<span class="ruby-identifier">singleton</span> <span class="ruby-operator">?</span> <span class="ruby-string">'class'</span> <span class="ruby-operator">:</span> <span class="ruby-string">'instance'</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>